<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fdk-aac: original/libSYS/include/syslib_channelMapDescr.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">fdk-aac
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ed137715e08969a186ec660e8ae6e2fb.html">original</a></li><li class="navelem"><a class="el" href="dir_abf7d4cbd5448271341442e73b756f52.html">libSYS</a></li><li class="navelem"><a class="el" href="dir_8619639418b31efc2d686e36f00ac6a2.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">syslib_channelMapDescr.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Function and structure declarations for the channel map descriptor implementation.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="machine__type_8h_source.html">machine_type.h</a>&quot;</code><br />
</div>
<p><a href="syslib__channel_map_descr_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_c_h_a_n_n_e_l___m_a_p___i_n_f_o.html">CHANNEL_MAP_INFO</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains information needed for a single channel map.  <a href="struct_c_h_a_n_n_e_l___m_a_p___i_n_f_o.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main data struct. It contains the mapping for all channel configurations such as administration information.  <a href="struct_f_d_k__channel_map_descr.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abeedc212a2bd3a4dfea00d69dca9c814"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslib__channel_map_descr_8h.html#abeedc212a2bd3a4dfea00d69dca9c814">FDK_chMapDescr_init</a> (<a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const pMapDescr, const <a class="el" href="struct_c_h_a_n_n_e_l___m_a_p___i_n_f_o.html">CHANNEL_MAP_INFO</a> *const pMapInfoTab, const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a> mapInfoTabLen, const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a> fPassThrough)</td></tr>
<tr class="memdesc:abeedc212a2bd3a4dfea00d69dca9c814"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a given channel map descriptor.  <a href="syslib__channel_map_descr_8h.html#abeedc212a2bd3a4dfea00d69dca9c814">More...</a><br /></td></tr>
<tr class="separator:abeedc212a2bd3a4dfea00d69dca9c814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb0b956dbb78104683cf01718335cff8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslib__channel_map_descr_8h.html#abb0b956dbb78104683cf01718335cff8">FDK_chMapDescr_setPassThrough</a> (<a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const pMapDescr, <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a> fPassThrough)</td></tr>
<tr class="memdesc:abb0b956dbb78104683cf01718335cff8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the channel reordering state of a given channel map descriptor.  <a href="syslib__channel_map_descr_8h.html#abb0b956dbb78104683cf01718335cff8">More...</a><br /></td></tr>
<tr class="separator:abb0b956dbb78104683cf01718335cff8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b5b998a1adf9d14cb7968af509fe5ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="machine__type_8h.html#aed5a2dbe32af3a91203f0f5e8697e873">UCHAR</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslib__channel_map_descr_8h.html#a4b5b998a1adf9d14cb7968af509fe5ea">FDK_chMapDescr_getMapValue</a> (const <a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const pMapDescr, const <a class="el" href="machine__type_8h.html#aed5a2dbe32af3a91203f0f5e8697e873">UCHAR</a> chIdx, const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a> mapIdx)</td></tr>
<tr class="memdesc:a4b5b998a1adf9d14cb7968af509fe5ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mapping value for a specific channel and map index.  <a href="syslib__channel_map_descr_8h.html#a4b5b998a1adf9d14cb7968af509fe5ea">More...</a><br /></td></tr>
<tr class="separator:a4b5b998a1adf9d14cb7968af509fe5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a3b761280f15863d17746138d4ac8c8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslib__channel_map_descr_8h.html#a3a3b761280f15863d17746138d4ac8c8">FDK_chMapDescr_isValid</a> (const <a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const pMapDescr)</td></tr>
<tr class="memdesc:a3a3b761280f15863d17746138d4ac8c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate whether channel map descriptor is reasonable or not.  <a href="syslib__channel_map_descr_8h.html#a3a3b761280f15863d17746138d4ac8c8">More...</a><br /></td></tr>
<tr class="separator:a3a3b761280f15863d17746138d4ac8c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:abac4c9332eb7d375b45cbf3e36a0a073"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_c_h_a_n_n_e_l___m_a_p___i_n_f_o.html">CHANNEL_MAP_INFO</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslib__channel_map_descr_8h.html#abac4c9332eb7d375b45cbf3e36a0a073">FDK_mapInfoTabWg4</a> []</td></tr>
<tr class="separator:abac4c9332eb7d375b45cbf3e36a0a073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefacdb48ed78a2c0394cb5533b6853d8"><td class="memItemLeft" align="right" valign="top"><a id="aefacdb48ed78a2c0394cb5533b6853d8"></a>
const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a>&#160;</td><td class="memItemRight" valign="bottom"><b>FDK_mapInfoTabLenWg4</b></td></tr>
<tr class="separator:aefacdb48ed78a2c0394cb5533b6853d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Function and structure declarations for the channel map descriptor implementation. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a4b5b998a1adf9d14cb7968af509fe5ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b5b998a1adf9d14cb7968af509fe5ea">&#9670;&nbsp;</a></span>FDK_chMapDescr_getMapValue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="machine__type_8h.html#aed5a2dbe32af3a91203f0f5e8697e873">UCHAR</a> FDK_chMapDescr_getMapValue </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const&#160;</td>
          <td class="paramname"><em>pMapDescr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="machine__type_8h.html#aed5a2dbe32af3a91203f0f5e8697e873">UCHAR</a>&#160;</td>
          <td class="paramname"><em>chIdx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a>&#160;</td>
          <td class="paramname"><em>mapIdx</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the mapping value for a specific channel and map index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pMapDescr</td><td>Pointer to channel map descriptor. </td></tr>
    <tr><td class="paramname">chIdx</td><td>Channel index. </td></tr>
    <tr><td class="paramname">mapIdx</td><td>Mapping index (corresponding to the channel configuration index). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Mapping value.</dd></dl>
<p>Get the mapping value for a specific channel and map index. </p>

</div>
</div>
<a id="abeedc212a2bd3a4dfea00d69dca9c814"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeedc212a2bd3a4dfea00d69dca9c814">&#9670;&nbsp;</a></span>FDK_chMapDescr_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FDK_chMapDescr_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const&#160;</td>
          <td class="paramname"><em>pMapDescr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_c_h_a_n_n_e_l___m_a_p___i_n_f_o.html">CHANNEL_MAP_INFO</a> *const&#160;</td>
          <td class="paramname"><em>pMapInfoTab</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a>&#160;</td>
          <td class="paramname"><em>mapInfoTabLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a>&#160;</td>
          <td class="paramname"><em>fPassThrough</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize a given channel map descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pMapDescr</td><td>Pointer to a channel map descriptor to be initialized. </td></tr>
    <tr><td class="paramname">pMapInfoTab</td><td>Table of channel maps to initizalize the descriptor with. If a NULL pointer is given a default table for WAV-like mapping will be used. </td></tr>
    <tr><td class="paramname">mapInfoTabLen</td><td>Length of the channel map table array (pMapInfoTab). If a zero length is given a default table for WAV-like mapping will be used. </td></tr>
    <tr><td class="paramname">fPassThrough</td><td>If the flag is set the reordering (given by pMapInfoTab) will be bypassed.</td></tr>
  </table>
  </dd>
</dl>
<p>Initialize the complete channel map descriptor. </p>

</div>
</div>
<a id="a3a3b761280f15863d17746138d4ac8c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a3b761280f15863d17746138d4ac8c8">&#9670;&nbsp;</a></span>FDK_chMapDescr_isValid()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FDK_chMapDescr_isValid </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const&#160;</td>
          <td class="paramname"><em>pMapDescr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Evaluate whether channel map descriptor is reasonable or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pMapDescr</td><td>Pointer to channel map descriptor. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value unequal to zero if descriptor is valid, otherwise zero.</dd></dl>
<p>Evaluate whether channel map descriptor is reasonable or not. </p>

</div>
</div>
<a id="abb0b956dbb78104683cf01718335cff8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb0b956dbb78104683cf01718335cff8">&#9670;&nbsp;</a></span>FDK_chMapDescr_setPassThrough()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FDK_chMapDescr_setPassThrough </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_f_d_k__channel_map_descr.html">FDK_channelMapDescr</a> *const&#160;</td>
          <td class="paramname"><em>pMapDescr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="machine__type_8h.html#afff0ab3629a68bc1bb3b2a2f4296173f">UINT</a>&#160;</td>
          <td class="paramname"><em>fPassThrough</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Change the channel reordering state of a given channel map descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pMapDescr</td><td>Pointer to a (initialized) channel map descriptor. </td></tr>
    <tr><td class="paramname">fPassThrough</td><td>If the flag is set the reordering (given by pMapInfoTab) will be bypassed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value unequal to zero if set operation was not successful. And zero on success.</dd></dl>
<p>Set channel mapping bypass flag in a given channel map descriptor. </p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="abac4c9332eb7d375b45cbf3e36a0a073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abac4c9332eb7d375b45cbf3e36a0a073">&#9670;&nbsp;</a></span>FDK_mapInfoTabWg4</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="struct_c_h_a_n_n_e_l___m_a_p___i_n_f_o.html">CHANNEL_MAP_INFO</a> FDK_mapInfoTabWg4[]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Extra variables for setting up Wg4 channel mapping. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
